Platform Explorer / Nuxeo Platform 2021.56

Contribution org.nuxeo.ecm.platform.audio.layouts--widgettypes

This contribution is part of XML component org.nuxeo.ecm.platform.audio.layouts inside nuxeo-platform-audio-jsf-2021.56.5.jar /OSGI-INF/layouts-contrib.xml

Extension Point

Extension point widgettypes of component WebLayoutManager.

Registration Order

16
The registration order represents the order in which this contribution was registered on its target extention point. This will impact the override/merge behaviour when it is implemented on the target service, and is useful for proper customization of existing contributions.
You can influence this order by adding "require" tags in the containing component declaration, to make sure it is resolved after another component (see "Resolution Order" on components).

Contributed Items

  • <widgetType name="audio_player">
          <configuration>
            <sinceVersion>5.8</sinceVersion>
            <title>Audio Player</title>
            <description>
              <p>This widgets displays a html5 or flash audio player</p>
            </description>
            <handlingLabels>true</handlingLabels>
            <categories>
              <!-- set configuration not ready until Studio knows how to manage that
                kind of configuration -->
              <category>configuration_not_ready</category>
              <!--
                <category>summary</category>
              -->
            </categories>
            <supportedModes>
              <mode>view</mode>
            </supportedModes>
            <fields>
              <list>false</list>
              <complex>false</complex>
              <layouts mode="any">
                <layout>
                  <rows>
                    <row>
                      <widget>field_0</widget>
                    </row>
                    <row>
                      <widget>field_1</widget>
                    </row>
                  </rows>
                  <widget name="field_0" type="text">
                    <labels>
                      <label mode="any">Bound document</label>
                    </labels>
                    <helpLabels>
                      <label mode="any">
                        The bound document can be referenced using
                        an empty field definition in a form layout, or using the
                        equivalent expression "#{value}". In a listing layout, it
                        can be referenced by using the value "data".
                      </label>
                    </helpLabels>
                    <properties mode="any">
                      <property name="resourceName">fields</property>
                    </properties>
                  </widget>
                  <widget name="field_1" type="selectOneResource">
                    <labels>
                      <label mode="any">File field binding</label>
                    </labels>
                    <properties mode="any">
                      <property name="resourceName">fields</property>
                      <property name="list">false</property>
                      <property name="complex">false</property>
                      <propertyList name="supportedTypes">
                        <value>blob</value>
                      </propertyList>
                    </properties>
                  </widget>
                </layout>
              </layouts>
            </fields>
            <properties>
              <layouts mode="view">
                <layout name="video_player_widget_type_properties_view">
                  <rows>
                    <row>
                      <widget>width</widget>
                    </row>
                  </rows>
                  <widget name="width" type="int">
                    <labels>
                      <label mode="any">Width</label>
                    </labels>
                    <helpLabels>
                      <label mode="any">
                        The width of the Audio player.
                      </label>
                    </helpLabels>
                    <fields>
                      <field>width</field>
                    </fields>
                  </widget>
                </layout>
              </layouts>
            </properties>
            <!-- no configurable properties -->
          </configuration>
          <handler-class>
            org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
          </handler-class>
          <property name="template">
            /widgets/audio_player_widget_template.xhtml
          </property>
        </widgetType>
  • <widgetType name="audio_file">
          <configuration>
            <sinceVersion>5.7.2</sinceVersion>
            <title>Audio File</title>
            <description>
              <p>
                The audio widget displays a file uploader/editor in create or edit
                mode, with additional message tag for errors.
              </p>
            </description>
            <properties>
              <layouts mode="edit">
                <layout name="audio_file_widget_type_properties_edit">
                  <rows>
                    <row>
                      <widget category="widgetTypeConf">required</widget>
                    </row>
                    <row>
                      <widget>acceptedExtensions</widget>
                    </row>
                  </rows>
                  <widget name="acceptedExtensions" type="text">
                    <labels>
                      <label mode="any">Accepted extensions</label>
                    </labels>
                    <helpLabels>
                      <label mode="any">
                        A comma separated list of supported file
                        extensions. Default value: '.mp3, .ogg, .oga, .flac, .m4a,
                        .aac, .ac3, .aif, .aiff, .aifc, .au, .snd, .asf, .wav'.
                      </label>
                    </helpLabels>
                    <fields>
                      <field>acceptedExtensions</field>
                    </fields>
                  </widget>
                </layout>
              </layouts>
            </properties>
            <categories>
              <category>document</category>
            </categories>
            <supportedModes>
              <mode>edit</mode>
              <mode>view</mode>
            </supportedModes>
            <fields>
              <list>false</list>
              <complex>false</complex>
              <supportedTypes>
                <type>blob</type>
              </supportedTypes>
            </fields>
          </configuration>
          <handler-class>
            org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
          </handler-class>
          <property name="template">/widgets/audio_file_widget_template.xhtml</property>
        </widgetType>

XML Source

<extension point="widgettypes" target="org.nuxeo.ecm.platform.forms.layout.WebLayoutManager">

    <widgetType name="audio_player">
      <configuration>
        <sinceVersion>5.8</sinceVersion>
        <title>Audio Player</title>
        <description>
          <p>This widgets displays a html5 or flash audio player</p>
        </description>
        <handlingLabels>true</handlingLabels>
        <categories>
          <!-- set configuration not ready until Studio knows how to manage that
            kind of configuration -->
          <category>configuration_not_ready</category>
          <!--
            <category>summary</category>
          -->
        </categories>
        <supportedModes>
          <mode>view</mode>
        </supportedModes>
        <fields>
          <list>false</list>
          <complex>false</complex>
          <layouts mode="any">
            <layout>
              <rows>
                <row>
                  <widget>field_0</widget>
                </row>
                <row>
                  <widget>field_1</widget>
                </row>
              </rows>
              <widget name="field_0" type="text">
                <labels>
                  <label mode="any">Bound document</label>
                </labels>
                <helpLabels>
                  <label mode="any">
                    The bound document can be referenced using
                    an empty field definition in a form layout, or using the
                    equivalent expression "#{value}". In a listing layout, it
                    can be referenced by using the value "data".
                  </label>
                </helpLabels>
                <properties mode="any">
                  <property name="resourceName">fields</property>
                </properties>
              </widget>
              <widget name="field_1" type="selectOneResource">
                <labels>
                  <label mode="any">File field binding</label>
                </labels>
                <properties mode="any">
                  <property name="resourceName">fields</property>
                  <property name="list">false</property>
                  <property name="complex">false</property>
                  <propertyList name="supportedTypes">
                    <value>blob</value>
                  </propertyList>
                </properties>
              </widget>
            </layout>
          </layouts>
        </fields>
        <properties>
          <layouts mode="view">
            <layout name="video_player_widget_type_properties_view">
              <rows>
                <row>
                  <widget>width</widget>
                </row>
              </rows>
              <widget name="width" type="int">
                <labels>
                  <label mode="any">Width</label>
                </labels>
                <helpLabels>
                  <label mode="any">
                    The width of the Audio player.
                  </label>
                </helpLabels>
                <fields>
                  <field>width</field>
                </fields>
              </widget>
            </layout>
          </layouts>
        </properties>
        <!-- no configurable properties -->
      </configuration>
      <handler-class>
        org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
      </handler-class>
      <property name="template">
        /widgets/audio_player_widget_template.xhtml
      </property>
    </widgetType>

    <widgetType name="audio_file">
      <configuration>
        <sinceVersion>5.7.2</sinceVersion>
        <title>Audio File</title>
        <description>
          <p>
            The audio widget displays a file uploader/editor in create or edit
            mode, with additional message tag for errors.
          </p>
        </description>
        <properties>
          <layouts mode="edit">
            <layout name="audio_file_widget_type_properties_edit">
              <rows>
                <row>
                  <widget category="widgetTypeConf">required</widget>
                </row>
                <row>
                  <widget>acceptedExtensions</widget>
                </row>
              </rows>
              <widget name="acceptedExtensions" type="text">
                <labels>
                  <label mode="any">Accepted extensions</label>
                </labels>
                <helpLabels>
                  <label mode="any">
                    A comma separated list of supported file
                    extensions. Default value: '.mp3, .ogg, .oga, .flac, .m4a,
                    .aac, .ac3, .aif, .aiff, .aifc, .au, .snd, .asf, .wav'.
                  </label>
                </helpLabels>
                <fields>
                  <field>acceptedExtensions</field>
                </fields>
              </widget>
            </layout>
          </layouts>
        </properties>
        <categories>
          <category>document</category>
        </categories>
        <supportedModes>
          <mode>edit</mode>
          <mode>view</mode>
        </supportedModes>
        <fields>
          <list>false</list>
          <complex>false</complex>
          <supportedTypes>
            <type>blob</type>
          </supportedTypes>
        </fields>
      </configuration>
      <handler-class>
        org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
      </handler-class>
      <property name="template">/widgets/audio_file_widget_template.xhtml</property>
    </widgetType>

  </extension>